Get All Reservations

Get all reservations.

HTTP Request

GET https://dev.calry.app/api/v2/vrs/reservations

Headers

Header	Value
Authorization	Bearer YOUR_ACCESS_TOKEN
workspaceId	YOUR_WORKSPACE_ID
integrationAccountId	YOUR_INTEGRATION_ACCOUNT_ID

Query Parameters

Parameter	Type	Description
realtime	bool	If true, the response will be streamed in real-time.
status	string	Lists all reservations with the specified status.
arrivalDate	string (YYYY-MM-DD)	Lists all reservations with an arrival date greater than your queried date.
departureDate	string (YYYY-MM-DD)	Lists all reservations with a departure date less than your queried date.
arrivalStartDate	string (YYYY-MM-DD)	Lists all reservations with an arrival date greater than to your queried date.
arrivalEndDate	string (YYYY-MM-DD)	Lists all reservations with an arrival date less than to your queried date.
departureStartDate	string (YYYY-MM-DD)	Lists all reservations with a departure date greater than to your queried date.
departureEndDate	string (YYYY-MM-DD)	Lists all reservations with a departure date less than to your queried date.
include	bool	Optional. Includes all the finance information of the reservation.

• If you want to filter reservations based on specified arrival dates, you can pass the arrivalStartDate and arrivalEndDate query parameters.

• If you don't have the sync engine turned on for OwnerRez integration, you can only fetch Inquiries or Quotes by passing status = INQUIRY or QUOTE, respectively. Example request: https://dev.calry.app/api/v1/vrs/reservations?status=INQUIRY

Example Request

curl --location 'https://dev.calry.app/api/v2/vrs/reservations' \
--header 'Authorization: Bearer eyJraWQiOiJzLWE5MGU1M2Q0LTJiNzktNDc2ZS1iNDA0LWI2YzQ2MzE2NmY5ZCIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjMwMDAvYXV0aCIsInVzZXJJZCI6IjVlNWRkMWE2LTA5NGItNDYjctNzUzYjlkZjJkMzFmIiwibmFtZSI6InRlc3QtdG9rZW4iLCJzb3VyY2UiOiJtaWNyb3NlcnZpY2UiLCJpYXQiOjE3MDA0Nzc0NDksImV4cCI6MTcwMDgzNzQ0OX0.XqZs7DfFI4PuxkNi3fxPZ-xKcNUtWdhUpVf34B05xRxkWqxlRYSO8OPTg6GEPmnAHwVknKdHzLukAowH4MPpHVTTIPM7gVdhkwCcI-sfJ_HFiBxT-myDN1pQGlp8uHbg0TmiOWe23ENuqAfIIAY_XZa6TzzOQdQzAsjhG8xamkxsgQxXdzYo_dUApfchYeZ5qCGodtF3BvB1mxBD-eQHTSY4VLk2zC2QY1vWIKMa_scWUWUJ4lqtqwawKUVOQlz2Hm_W7Z9RBF7InJbrLBYK1EB6YSVLyeBz1Y-CdysBupuYn2130MXHauPNZcf9z_05g59XBXMW5_Qstcs-EaEntw' \
--header 'workspaceId: 7246e4f5-d8f2-4c01-abb7-753b9df2d31f' \
--header 'integrationAccountId: a2e1738e-9e30-4ba0-808a-fd3f1ce6369a'

Example Response

{
    "data" : [
        {
            "id": "23609077",
            "createdAt": "2024-01-23T22:30:18.000Z",
            "updatedAt": "2024-01-23T22:30:18.000Z",
            "cancelledAt": "",
            "arrivalDate": "2024-03-10",
            "departureDate": "2024-03-12",
            "nights": 2,
            "propertyId": "212815",
            "unitIds": [
                "212729"
            ],
            "roomTypeIds":[
                "312277"
            ],
            "numberOfGuests": 3,
            "primaryGuest": {
                "name": "Alice Johnson",
                "emails": [
                    "alicej@example.com"
                ],
                "nameLast": "Johnson",
                "pictures": [
                    "https://a0.muscache.com/im/Portrait/Avatars/messaging/b3e03835-ade9-4eb7-a0bb-2466ab9a534d.jpg?im_policy=medq_w_text&im_t=J&im_w=240&im_f=airbnb-cereal-medium.ttf&im_c=ffffff"
                ],
                "addresses": {
                    "city": "Laketown",
                    "line1": "456 Oak Lane Suite 12",
                    "country": "Wonderland",
                    "postal_code": "67890"
                },
                "nameFirst": "Alice",
                "mobileNumbers": [
                    "+9876543210"
                ],
                "preferredLanguage": {
                    "code": "en",
                    "name": "ENGLISH"
                }
            },
            "numberOfAdults": 2,
            "numberOfChildren": 1,
            "numberOfInfants": 0,
            "numberOfPets": 1,
            "source": "direct",
            "totalPrice": 950,
            "currency": "USD",
            "status": "new"
        },
        {
            "id": "23608341",
            "createdAt": "2024-01-23T21:45:43.000Z",
            "updatedAt": "2024-01-23T21:45:43.000Z",
            "cancelledAt": "",
            "arrivalDate": "2024-02-15",
            "departureDate": "2024-02-20",
            "nights": 5,
            "propertyId": "212815",
            "unitIds": [
                "212729"
            ],
            "roomTypeIds":[
                "312277"
            ],            
            "numberOfGuests": 4,
            "primaryGuest": {
                "name": "John Doe",
                "emails": [
                    "johndoe@email.com"
                ],
                "nameLast": "Doe",
                "pictures": [
                    null
                ],
                "addresses": {
                    "city": "Anytown",
                    "line1": "123 Main Street Apt 4",
                    "country": "Countryland",
                    "postal_code": "12345"
                },
                "nameFirst": "John",
                "mobileNumbers": [
                    "+1234567890"
                ],
                "preferredLanguage": {
                    "code": null,
                    "name": ""
                }
            },
            "numberOfAdults": 2,
            "numberOfChildren": 1,
            "numberOfInfants": 1,
            "numberOfPets": 0,
            "source": "direct",
            "totalPrice": 800,
            "currency": "USD",
            "status": "new"
        }
    ],
    "meta": {
        "limit": 10,
        "cursors": {
            "previous": "",
            "current": "1",
            "next": ""
        }
    }
}